Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[TRA-233] Fix IsIsolatedPerpetual function orientation #1403

Merged
merged 2 commits into from
Apr 23, 2024
Merged

[TRA-233] Fix IsIsolatedPerpetual function orientation #1403

merged 2 commits into from
Apr 23, 2024

Conversation

shrenujb
Copy link
Contributor

Changelist

Currently, IsIsolatedPerpetual returns True for cross perpetuals and its callers expect the same, which is the wrong orientation for the function. This change fixes this behavior

Test Plan

Existing tests

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

@shrenujb
Fix IsIsolatedPerpetual function orientation
a94c952 
Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>
@linear Linear
Copy link

linear bot commented Apr 23, 2024

TRA-233 Fix IsIsolatedPerpetual function based on internal audit

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 23, 2024 •
edited
Loading

Walkthrough

The recent changes in the codebase focus on enhancing the logic related to the isolation status of perpetuals and subaccounts. The updates bring improved clarity and consistency in handling isolated conditions by refining the determination of isolation status based on market type and adjusting return values based on the isolation condition.

Changes

File Path Change Summary
.../perpetuals/keeper/perpetual.go Updated IsIsolatedPerpetual to determine isolation status using market type instead of insurance fund name.
.../subaccounts/keeper/negative_tnc_subaccount.go Adjusted return logic in getNegativeTncSubaccountStoreSuffix based on the isIsolated condition.
Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between a94c952 and b7051e5.
Files selected for processing (1)
  • protocol/x/perpetuals/keeper/perpetual_test.go (1 hunks)
Additional Context Used
Path-based Instructions (1)
protocol/x/perpetuals/keeper/perpetual_test.go (1)

Pattern **/**: Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.

Additional comments not posted (1)
protocol/x/perpetuals/keeper/perpetual_test.go (1)

3545-3576: The test function TestIsIsolatedPerpetual is well-implemented. It correctly sets up test cases for both isolated and cross perpetuals, and it uses assertions effectively to ensure the IsIsolatedPerpetual method behaves as expected.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@vincentwschau
Copy link
Contributor

nit: Non-blocking, mind adding a simple test here?

@shrenujb
add unit test
b7051e5 
Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>
@shrenujb shrenujb merged commit fa2117e into main Apr 23, 2024
16 of 17 checks passed
@shrenujb shrenujb deleted the tra233 branch April 23, 2024 21:15
@teddyding
Copy link
Contributor

@Mergifyio backport release/protocol/v5.x

@mergify Mergify
Copy link
Contributor

mergify bot commented Apr 23, 2024 •
edited
Loading

backport release/protocol/v5.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Apr 23, 2024
@shrenujb @mergify
[TRA-233] Fix IsIsolatedPerpetual function orientation (#1403)
9770d2e 
Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>
(cherry picked from commit fa2117e)
@mergify mergify bot mentioned this pull request Apr 23, 2024
Merged
6 tasks
shrenujb added a commit that referenced this pull request Apr 24, 2024
@mergify @shrenujb
[TRA-233] Fix IsIsolatedPerpetual function orientation (#1403) (#1406)
2f568c9 
Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>
(cherry picked from commit fa2117e)

Co-authored-by: shrenujb <98204323+shrenujb@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vincentwschau vincentwschau vincentwschau approved these changes

Assignees
No one assigned
Labels
backport/protocol/v5.x protocol
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@shrenujb @vincentwschau @teddyding